package com.demo.jdksource;

import java.util.*;

/**、
 * 我自己的ArrayList
 * ArrayList使用的存储的数据结构
 * ArrayList的初始化
 * ArrayList是如何动态增长
 * ArrayList如何实现元素的移除
 * ArrayList小结
 * 1 实现原理使用动态对象数组实现，默认构造方法创建一个空数组；
 *
 * 2 第一次添加元素，默认扩充容量为10；之后的扩充的算法是
 * 原来的大小+原来的数组大小/2;
 *
 * 3 动态数组不适合删除和动态插入方式，会导致位置会变；
 *
 * 4 为了防止数据动态扩充次数太多，建议ArrayList给出初始容量；
 *
 * 5 线程不安全，不适合放到多个线程的公共变量；
 *
 * 6当添加一个新元素的时候，首先会检查容量是否足够添加这个元素，如果够就直接添加，如果不够就进行扩容，扩容为原数组容量的1.5倍
 * 7当在index处放置一个元素的时候，会将数组index处右边的元素全部右移
 * 8当在index处删除一个元素的时候，会将数组index处右边的元素全部左移
 * Created by xi on 2019/3/2.
 */
public class MyArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable {

    private static final long serialVersionUID = 8683452581122892189L;

    /**
     * 默认初始化长度
     */
    private static final int DEFAULT_CAPACITY = 10;

    /**
     * 用于空实例的共享空数组实例
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /**
     用于默认大小的空实例的共享空数组实例。
     我们将此与EMPTY_ELEMENTDATA区分开来，以便在添加第一个元素时知道要膨胀多少。


     注释中解释的很清楚，就是说刚初始化的时候，会是一个共享的类变量，
     也就是一个Object空数组，当第一次add的时候，这个数组就会被初始化一个大小为10的数组。
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     * 存储ArrayList元素的数组缓冲区。 *
     * ArrayList的容量是此数组缓冲区的长度。添加第一个元素时，
     * 任何带有elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA
     * 的空ArrayList都将扩展为DEFAULT_CAPACITY。
     */
    transient Object[] elementData; // non-private to simplify nested class access

    /**
     * The size of the ArrayList (the number of elements it contains).
     *
     * @serial
     */
    private int size;

    protected transient int modCount = 0;

    /**
     * The maximum size of array to allocate.
     * Some VMs reserve some header words in an array.
     * Attempts to allocate larger arrays may result in
     * OutOfMemoryError: Requested array size exceeds VM limit
     */
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    /**1 ArrayList 如何初始化的****/
    //初始化

    /**
     *
     * 上述代码很容易理解，如果用户指定的初始化容量大于0，就new一个相应大小的数组，
     * 如果指定的大小为0，就复制为共享的那个空的Object数组对象。如果小于0，就直接抛出异常。
     * @param initialCapacity
     */
    public MyArrayList(int initialCapacity) {
      if(initialCapacity > 0 ) {
          elementData = new Object[]{initialCapacity};
      }else if (initialCapacity == 0){
          elementData = EMPTY_ELEMENTDATA;
      }else{
          throw new IllegalArgumentException("Illegal Capacity: "+
                  initialCapacity);
      }
    }

    /**
     * Constructs an empty list with an initial capacity of ten.
     * 构造一个初始容量为10的空列表
     * 注释中解释的很清楚，就是说刚初始化的时候，会是一个共享的类变量，
     * 也就是一个Object空数组，当第一次add的时候，这个数组就会被初始化一个大小为10的数组。
     */
    public MyArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    /**
     * 第三个构造函数，传入一个集合
     * @return
     * Set<Integer> set = new HashSet<>();
     *         set.add(1);
     *         set.add(2);
     *         set.add(3);
     *         set.add(4);
     * ArrayList<Integer> list = new ArrayList<>(set);
     */

    public MyArrayList (Collection<? extends E> c){
        elementData = c.toArray();
        if((size = elementData.length)!=0){
            if(elementData.getClass()!=Object[].class){
                elementData = Arrays.copyOf(elementData,size,Object[].class);
            }
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }


  //2 ArrayList是如何动态增长

    /**
     * 当我们像一个ArrayList中添加数组的时候，首先会先检查数组中是不是有足够的空间来存储这个新添加的元素。
     * 如果有的话，那就什么都不用做，直接添加。
     * 如果空间不够用了，那么就根据原始的容量增加原始容量的一半。
      * @param e
     * @return
     */

  @Override
  public boolean add(E e) {
        ensureCapacityInternal(size+1);
        //size++又代表了元素将要放到的小标，又代表了加入之后的长度；
        elementData[size++]=e;
        return  true;
  }

   //判断内部容量
    //这里需要思考的问题？1 第一次构造一个长度的数组，2 扩容的问题
    private   void ensureCapacityInternal(int minCapacity) {
//        int arrayLen = elementData.length;
//        if(elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA){
//            elementData = new Object[DEFAULT_CAPACITY];
//        }else {
//            if(arrayLen  < minCapacity){
//                //需要扩容了
//                ensureExplicitCapacity(minCapacity);
//            }
//        }

        //传入进来的和默认大小比较，取最大，第一次，肯定最小容量都是默认值；从第一次到默认值之间的时候；
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
         ensureExplicitCapacity(minCapacity);
    }

    /**
     * 扩充准确的容量
     * @param minCapacity
     */
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0) {
             grow(minCapacity);
        }
    }

    /**
     * Increases the capacity to ensure that it can hold at least the
     * number of elements specified by the minimum capacity argument.
     *
     * @param minCapacity the desired minimum capacity
     */
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);//除以2
        //最小值的容量
        if (newCapacity - minCapacity < 0) {
            newCapacity = minCapacity;
        }
        //最大容量
        if (newCapacity - MAX_ARRAY_SIZE > 0){
            newCapacity = hugeCapacity(minCapacity);
        }
        // minCapacity通常接近大小，所以这是一个胜利，把 elementData 扩充成新的长度
        elementData = Arrays.copyOf(elementData, newCapacity);
    }


        private static int hugeCapacity(int minCapacity) {
            if (minCapacity < 0) // overflow
                throw new OutOfMemoryError();
            return (minCapacity > MAX_ARRAY_SIZE) ?
                    Integer.MAX_VALUE :
                    MAX_ARRAY_SIZE;
        }


    //将指定的元素(E e)插入到列表的指定位置(index)
    public void add(int index, E element) {
        rangeCheckForAdd(index); //判断参数index是否IndexOutOfBoundsException

        ensureCapacityInternal(size + 1);  // Increments modCount!!  如果数组长度不足，将进行扩容
        System.arraycopy(elementData, index, elementData, index + 1,
                size - index); //将源数组中从index位置开始后的size-index个元素统一后移一位
        elementData[index] = element;//然后再把新加入的数据放在index这个位置，而之前的数据不需要移动
        size++;
    }

    /**
     * 按照指定collection的迭代器所返回的元素顺序，将该collection中的所有元素添加到此列表的尾部
     * @throws NullPointerException if the specified collection is null
     */
    public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        //将数组a[0,...,numNew-1]复制到数组elementData[size,...,size+numNew-1]
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }


    /**
     * 从指定的位置开始，将指定collection中的所有元素插入到此列表中，
     * 新元素的顺序为指定collection的迭代器所返回的元素顺序
     * @throws IndexOutOfBoundsException {@inheritDoc}
     * @throws NullPointerException if the specified collection is null
     */
    public boolean addAll(int index, Collection<? extends E> c) {
        rangeCheckForAdd(index); //判断参数index是否IndexOutOfBoundsException
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        int numMoved = size - index; //代表需要size中索引到size的有几个数据需要后移动
        if (numMoved > 0) {
            //先将数组elementData[index,...,index+numMoved-1]复制到elementData[index+numNew,...,size+numnew-1]
            //即，将源数组中从index位置开始的后numMoved个元素统一后移numNew位
            System.arraycopy(elementData, index, elementData, index + numNew,numMoved);
        }
        //再将数组a[0,...,numNew-1]复制到数组elementData[index,...,index+numNew-1]
        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }




    /**
     * A version of rangeCheck used by add and addAll.
     * 索引必须比已经的放的大了，size,如果是1代表已经有个1元素，下标为1，代表在这个元素之后增加
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }


    /**
     * Constructs an IndexOutOfBoundsException detail message.
     * Of the many possible refactorings of the error handling code,
     * this "outlining" performs best with both server and client VMs.
     */
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 移除此列表中指定位置上的元素
     * @param index 需被移除的元素的索引
     * @return the element 被移除的元素值
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E remove(int index) {
        rangeCheck(index);  //判断index是否 <= size

        modCount++;
        E oldValue = elementData(index);
        //将数组elementData中index位置之后的所有元素向前移一位
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        elementData[--size] = null; //将原数组最后一个位置置为null，由GC清理

        return oldValue;
    }

    //移除ArrayList中首次出现的指定元素(如果存在)，ArrayList中允许存放重复的元素
    public boolean remove(Object o) {
        // 由于ArrayList中允许存放null，因此下面通过两种情况来分别处理。
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index); //私有的移除方法，跳过index参数的边界检查以及不返回任何值
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

    //私有的删除指定位置元素的方法，跳过index参数的边界检查以及不返回任何值
    private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

    //清空ArrayList，将全部的元素设为null
    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

    //删除ArrayList中从fromIndex（包含）到toIndex（不包含）之间所有的元素，共移除了toIndex-fromIndex个元素
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;  //需向前移动的元素的个数
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }

    //删除ArrayList中包含在指定容器c中的所有元素
    public boolean removeAll(Collection<?> c) {
        Objects.requireNonNull(c);  //检查指定的对象c是否为空
        return batchRemove(c, false);
    }

    //移除ArrayList中不包含在指定容器c中的所有元素，与removeAll(Collection<?> c)正好相反
    public boolean retainAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, true);
    }

    private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;  //读写双指针
        boolean modified = false;
        try {
            for (; r < size; r++)
                if (c.contains(elementData[r]) == complement) //判断指定容器c中是否含有elementData[r]元素
                    elementData[w++] = elementData[r];
        } finally {
            // Preserve behavioral compatibility with AbstractCollection,
            // even if c.contains() throws.
            if (r != size) {
                System.arraycopy(elementData, r,
                        elementData, w,
                        size - r);
                w += size - r;
            }
            if (w != size) {
                // clear to let GC do its work
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }



    //将指定索引上的值替换为新值，并返回旧值
    /**
     * Replaces the element at the specified position in this list with
     * the specified element.
     *
     * @param index index of the element to replace
     * @param element element to be stored at the specified position
     * @return the element previously at the specified position
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E set(int index, E element) {
        rangeCheck(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

    @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }


        @Override
        public int size() {
            return 0;
        }

    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

    //正向查找，返回ArrayList中元素Object o第一次出现的位置，如果元素不存在，则返回-1
    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    //逆向查找，返回ArrayList中元素Object o最后一次出现的位置，如果元素不存在，则返回-1
    public int lastIndexOf(Object o) {
        if (o == null) {
            for (int i = size-1; i >= 0; i--)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = size-1; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }


    //返回指定索引处的值
    public E get(int index) {
        rangeCheck(index);

        return elementData(index); //实质上return (E) elementData[index]
    }

}
